ATSUClearFontVariations

OSStatus ATSUClearFontVariations (
                     ATSUStyle iStyle,
                     ItemCount iAxisCount,
                     ATSUFontVariationAxis iAxes[]);

iStyle

A reference of type ATSUStyle. Pass a reference to a valid style object whose font variations you want to remove. You cannot pass NULL for this parameter.

iAxisCount

The number of font variations you want to remove. To remove all previously set font variations, pass the constant kATSUClearAll in this parameter. In this case, the value in the iAxes parameter will be ignored.

iAxes

An array of values of type ATSUFontVariationAxis. Each element in the array must contain a valid variation axis that corresponds to the variation value you want to remove.

function result

A result code. See Result Codes. You can remove unset font variation values from a style object without a function error.

DISCUSSION

The ATSUClearFontVariations function removes those previously set font variations identified in the iAxes array. It replaces them with their font-defined default values.

If you wish to remove all previously set font variations from a style object, pass kATSUClearAll in the iAxisCount parameter. To remove all previously set style run attribute, font feature, and font variation values from a style object, call the function ATSUClearStyle. To remove just the previously set font features from a style object, call the function ATSUClearFontFeatures.

VERSION NOTES

Available beginning with ATSUI 1.0.